home *** CD-ROM | disk | FTP | other *** search
/ Just Call Me Internet / Just Call Me Internet.iso / prog / atari / c / dev_lib / lib_com / device.txt < prev    next >
Text File  |  1995-05-07  |  5KB  |  136 lines
  1.  
  2.   DEVICE.LIB - written by Jan Kriesten 
  3. ================================================================================
  4.   (c) 1994,1995 by Jan Kriesten, all rights reserved.
  5.   
  6.       Author:   Jan Kriesten
  7.                 Friedhofstr. 25 b
  8.                 35043 Marburg
  9.                 Germany
  10.       EMail:    Maus GI
  11.                 90:400/1002@nest.ftn
  12.                 51:601/103@atarinet.ftn
  13.                 2:2435/707@fidonet.org
  14.                 kriesten@Mailer.Uni-Marburg.DE
  15.   
  16. ================================================================================
  17.   
  18. Introduction:
  19. =============
  20.  
  21.   It's the same everytime. You write a program and have to write parts
  22.   of it other programmers have written long time ago for themselves, too.
  23.   
  24.   That was the same for me, too. I was to be writing a new fidonet
  25.   mailer and had to do a lot of research to design all the port i/o 
  26.   routines which were written by other authors before. Also, the different
  27.   device drivers (HSModem, FastSerial, ...) needed different support. In
  28.   fact I wished there had been a couple of routines which would have made
  29.   my life easier.
  30.   
  31.   This is the reason I give this library to public. The library contains
  32.   many useful i/o routines for using the ports of your atari. Also it's
  33.   supporting HSModem and MiNT block device drivers as well as FastSerial.
  34.  
  35. Copyright:
  36. ==========
  37.   
  38.   Copyright (c) 1994, 1995 by Jan Kriesten
  39.   
  40.   Please notice that the library is not 'public domain' or 'freeware',
  41.   but it's allowed to spread it out (without charging fees) via public
  42.   BBS or public networks like FidoNet. In any case the original archive
  43.   has to be spread out and must not be modified.
  44.   
  45.   It's not allowed to make this library available via other channels like
  46.   pd disk series, cd rom's or channel videodat.
  47.   
  48.   Using this library in commercial/shareware programs is only allowed with
  49.   permission of the author.
  50.   
  51. Disclaimer:
  52. ===========
  53.   
  54.   Every care is taken to ensure that these routines are bug free and will
  55.   not cause any trouble on your system.
  56.   
  57.   However, I take no responsibility for any harm that may occur to your
  58.   system by using this library.
  59.   
  60. Description:
  61. ============
  62.   
  63.   The library is designed to be used together with PureC. To use the 
  64.   routines you just have to move device.h and device.lib to the corres-
  65.   ponding include/library folder of PureC and add device.lib to your
  66.   project file.
  67.   
  68.   Please notice that if you're running MiNT without HSModem or FastSerial
  69.   started after it in the `Auto' folder, the device library changes
  70.   to the MiNT process execution domain to handle device-I/O in a correct
  71.   way. That means to you that Fread/Fwrite will follow the terminal
  72.   settings (which needs not to be 'RAW' mode!) - actually I don't know
  73.   if this is only valid for devices or also for files. Also filenames
  74.   returned by Fsfirst/Fsnext may be treated differently, i.e. differencing
  75.   between upper/lower case or filenames longer than 8+3 characters.
  76.   This can also effect programs started by yours via Pexec()!
  77.   
  78.   The following routines are available. Please refer to the file
  79.   device.h for further descriptions:
  80.   
  81.   DEV_LIST *InitDevices ( VOID *pause_normal, VOID *pause_super );
  82.   VOID     TermDevices  ( VOID );
  83.   BOOLEAN  OpenDevice   ( DEV_LIST *port );
  84.   VOID     CloseDevice  ( DEV_LIST *port );
  85.   VOID     PortParameter( DEV_LIST *port, UWORD flowctl, UWORD charlen, UWORD stopbits, UWORD parity );
  86.   WORD     GetBiosNr    ( DEV_LIST *port );
  87.   LONG     *GetSpeedList( DEV_LIST *port );
  88.   LONG     SetDTESpeed  ( DEV_LIST *port, LONG speed );
  89.   
  90.   BOOLEAN  PortSendByte ( DEV_LIST *port, BYTE c );
  91.   BOOLEAN  PortSendBlock( DEV_LIST *port, BYTE *block, LONG len, BOOLEAN tst_dcd );
  92.   WORD     PortGetByte  ( DEV_LIST *port );
  93.   WORD     PortPeekByte ( DEV_LIST *port );
  94.   
  95.   BOOLEAN  OutIsEmpty   ( DEV_LIST *port );
  96.   BOOLEAN  WaitOutEmpty ( DEV_LIST *dev, BOOLEAN tst_dcd, UWORD wait_hundreds );
  97.   BOOLEAN  CharAvailable( DEV_LIST *port );
  98.   VOID     ClearIOBuffer( DEV_LIST *port, LONG which );
  99.   
  100.   VOID     DtrOn        ( DEV_LIST *port );
  101.   VOID     DtrOff       ( DEV_LIST *port );
  102.   BOOLEAN  IsCarrier    ( DEV_LIST *port );
  103.   VOID     StartReceiver( DEV_LIST *port );
  104.   VOID     StopReceiver ( DEV_LIST *port );
  105.   
  106.   WORD     SetRxBuffer  ( DEV_LIST *port, WORD size );
  107.   WORD     GetRxBuffer  ( DEV_LIST *port );
  108.   WORD     SetTxBuffer  ( DEV_LIST *port, WORD size );
  109.   WORD     GetTxBuffer  ( DEV_LIST *port );
  110.   
  111.   VOID     get_tos      ( WORD *tos );
  112.   BOOLEAN  getcookie    ( LONG cookie, LONG *value );
  113.   ULONG    Get200Hz     ( VOID );
  114.   ULONG    Calc200Hz    ( ULONG time_to_set );
  115.  
  116. Trailer:
  117. ========
  118.   
  119.   This library will be supported - or not. This is depending on how
  120.   many people are using - and supporting - this library. If you like
  121.   this library and you're using it in your own programs you should think
  122.   of making a donation for it. Any donation is welcome and will increase
  123.   my motivation of supporting it further.
  124.   
  125.   My bank account:
  126.   
  127.   Jan Kriesten, Citibank
  128.                 Kto.-Nr. 0910680784
  129.                 BLZ      300 209 00
  130.   
  131.   Any suggestions or bug reports please send to any of the above EMail
  132.   adresses.
  133.  
  134. =============================[ End of DEVICE.TXT ]==============================
  135.  
  136.